Skip to content

Add polish improvements: badges, changelog, better errors, examples#2

Merged
anneschuth merged 1 commit into
mainfrom
nice-improvements
Jan 22, 2026
Merged

Add polish improvements: badges, changelog, better errors, examples#2
anneschuth merged 1 commit into
mainfrom
nice-improvements

Conversation

@anneschuth

Copy link
Copy Markdown
Member

Summary

  • Add CI, license, and version badges to README for better visibility
  • Create CHANGELOG.md following Keep a Changelog format
  • Add SPDX-License-Identifier headers to action files for compliance scanning
  • Improve error messages with user-friendly guidance for common failure scenarios
  • Add more workflow examples demonstrating real-world use cases

Changes

Badges (README.md)

  • CI status badge
  • License badge (EUPL-1.2)
  • GitHub release version badge

CHANGELOG.md

  • Follows Keep a Changelog format
  • Documents v1.0.0 features and the unreleased CI/governance work

Error Messages (action.yml files)

User-friendly error messages for:

  • Network connection failures (HTTP 000)
  • Authentication errors (HTTP 401)
  • Permission denied (HTTP 403)
  • Not found errors (HTTP 404)
  • Server errors (HTTP 5xx)

SPDX Headers

Added # SPDX-License-Identifier: EUPL-1.2 to both action files

Workflow Examples

deploy/README.md:

  • Multi-component matrix deployments
  • Conditional branch-based deployments
  • Deployment with health check

cleanup/README.md:

  • Scheduled stale environment cleanup
  • Conditional cleanup based on outputs

Test plan

  • Verify badges render correctly on GitHub
  • Check CHANGELOG.md formatting
  • Verify CI passes (shellcheck, actionlint, yamllint)
  • Review example workflows for accuracy

- Add CI, license, and version badges to README.md
- Create CHANGELOG.md with proper Keep a Changelog format
- Add SPDX-License-Identifier headers to action files
- Improve error messages with user-friendly guidance:
  - Network connection failures (HTTP 000)
  - Authentication errors (HTTP 401)
  - Permission denied (HTTP 403)
  - Not found errors (HTTP 404)
  - Server errors (HTTP 5xx)
- Add more workflow examples to READMEs:
  - Multi-component matrix deployments
  - Conditional branch-based deployments
  - Deployment health checks
  - Scheduled stale environment cleanup
  - Conditional cleanup based on outputs
- Quote GITHUB_OUTPUT consistently for shellcheck compliance
@anneschuth anneschuth merged commit 6072d88 into main Jan 22, 2026
3 checks passed
@anneschuth anneschuth deleted the nice-improvements branch January 22, 2026 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant